home *** CD-ROM | disk | FTP | other *** search
/ Aminet 2 / Aminet AMIGA CDROM (1994)(Walnut Creek)[Feb 1994][W.O. 44790-1].iso / Aminet / comm / bbs / VOTE_1_0b.lha / VOTE.doc < prev   
Text File  |  1992-04-15  |  10KB  |  224 lines
  1.                            ---------------------
  2.                            THE VOTING BOOTH 1.0b
  3.                            ---------------------
  4.                                      by
  5.                                 Tom Warkentin
  6.                              Copyright (C) 1992
  7.  
  8. -----------------------------------------------------------------------------
  9. This software is FREEWARE and may distributed so long as the following
  10. files are included in the archive:
  11.  
  12.     VOTE         -        the executable file
  13.     VOTE.doc     -        docs on setting it up
  14.     README       -        this file
  15.  
  16. Any archiving method may be used, however nothing can be added or ommitted
  17. from the archive. Furthermore, the files mentioned above may not be modified
  18. in any way.  Under no circumstances can a fee be charged for the distribution
  19. of the files!
  20. -----------------------------------------------------------------------------
  21. INSTALLATION:
  22.  
  23.     The executable can be placed anywhere you want it, however you
  24. must assign VOTE: to the directory where you've placed the file.  Also
  25. keep in mind that the Voting Booth will create subdirectories and data
  26. files, therefore I would recommend you placing it in it's own directory.
  27. For DLG owners, your best bet is to place it in the DOORS: directory.
  28. Here's how I set it up on my hard drive.
  29.  
  30.     CD DOORS:
  31.     MAKEDIR VOTE
  32.     ASSIGN VOTE: DOORS:VOTE
  33.  
  34. Now make sure you place the executable in VOTE: and create a menu item
  35. so users can access it from the BBS.  Also, you might want to take some
  36. time to setup some topics and choices so the users have an idea of what
  37. you want added to the booth.
  38.  
  39. ADDING MENU ITEM:
  40.  
  41.     I'll go through the setup for DLG owners. If you're using some
  42. other BBS package, you should get the general idea from reading the
  43. setup procedure.
  44.  
  45.     USAGE:
  46.  
  47.         VOTE %UNAME "%ALIAS" %LEVEL %ANSI %SCWIDTH 1
  48.  
  49.     The Voting Booth uses the underscored username to ensure that a
  50. user will not vote twice for a topic.  The alias part may be replaced by
  51. the users real name. Whatever you decide to put in quotations is what the
  52. user will actually see as the names of users using the booth.  The user
  53. level must be included to control access to the SysOp configuration menu
  54. as well as to control user additions to the booth (must be an integer).
  55. The ansi flag is either "color" or "mono" depending on the users current
  56. settings.  Screen width is used to either print two columns of menu items
  57. or single columns.  The "1" on the end of the line is used to determine
  58. which config file to use for the booth and where to look for the data
  59. files.  If you plan on running multiple booths, you should choose a
  60. unique number for each.
  61.  
  62. Here's my setup on DLGPro v0.991:
  63.  
  64. [ 1] Letter:               V
  65. [ 2] Executable:           VOTE:VOTE %UNAME "%ALIAS" %LEVEL %ANSI %SCWIDTH 1
  66. [ 4] Description:          Voting Booth
  67. [ 5] Type:                 Executable
  68. [ 6] Help File:            MAIN/V
  69. [ 7] Lower level:          10
  70. [ 8] Upper level:          255
  71. [ 9] Hidden:               NO
  72. [10] Load type:            OVERLAY
  73. [11] Ask user if sure:     NO
  74. [12] Pend Messages:        YES
  75. [13] CLI mode:             NO
  76. [14] Pause on completion:  NO
  77. [15] Log value:            None
  78. [16] Activity string:
  79. [17] Priority:             1
  80. [18] Edit help file
  81.  
  82. THE MENUS:
  83.  
  84. ---------------------------------------------------------------------------
  85. SysOp Configuration
  86. ---------------------------------------------------------------------------
  87. [A] Add A New Topic                 [D] Delete A Topic
  88. [E] Edit A Topic                    [G] Global Settings
  89. [R] Reset Booth
  90. ---------------------------------------------------------------------------
  91.  M
  92. ---------------------------------------------------------------------------
  93. SYSOP CONFIG =>
  94.  
  95. [A] Add A New Topic - This command is that same as the users Add A New Topic
  96.               command from the main menu.  It will ask for a
  97.               description of the topic followed by a choice for
  98.               users to vote on.
  99. [D] Delete A Topic  - This will list all available topics in the Voting
  100.               Booth and let you select the one you'd like to remove.
  101.               Before removing the topic, the program will ask for
  102.               one confirmation.  Then it will update the config
  103.               files as well as each users votes to reflect the
  104.               deleted topic.
  105. [E] Edit A Topic    - This command allows the SysOp to edit a topic
  106.               description, creator, as well as the individual
  107.               choices, their creator, and the number of votes. This
  108.               feature was added in case users enter unsightly
  109.               descriptions that need to be censored by the SysOp.
  110. [G] Global Settings - The SysOp can edit the title displayed at the main
  111.               menu of the Voting Booth.  The default is "Voting
  112.               Booth 1.0b".  Also you can set the user level for user
  113.               additions, the SysOp user level (controls access to
  114.               SysOp Configuration Menu), the maximum number of topics,
  115.               and the maximum number of topics.  All integer settings
  116.               have maximum and mininum values.  If the value entered
  117.               is beyond the max and min bounds, that value will be
  118.               skipped and a message indicating the bounds will be
  119.               displayed.
  120. [R] Reset Booth     - This command will erase all user votes and delete all
  121.               topics and their associated choices.  Two confirmations
  122.               are necessary before this command is invoked.  Once
  123.               invoked, it is irreversible.  Simply pressing any key
  124.               besides 'Y' cancels the command.
  125.  
  126. Review A Topic:
  127.  
  128.      This menu will allow a user to view the results of user voting.  However,
  129. only those topics the user has participated in will be displayed. This is
  130. an attempt to not bias the results.  Future additions to reviewing a topic
  131. may include graphing user votes for comparison.  Version 1.0 does not have
  132. this feature implemented and future versions depend on user feedback.
  133.  
  134. Vote On A Topic:
  135.  
  136.      This menu allows the user to select a topic to vote on.  If ansi is
  137. selected, topics that are written in red lettering indicate topics that
  138. have been voted on while green indicates topics not voted on.  For those
  139. users with ansi turned off, an asterisk will replace the colors (asterisk
  140. indicating topics already voted on).  When viewing choices, if the user
  141. has already voted on the topic, the choice he/she voted on will be displayed
  142. in red. Also [-] will be displayed for each choice indicating that the topic
  143. cannot be voted on again.  A proposed enhancement would be to allow users
  144. to change their votes as new additions are made.  However this would bias
  145. the results somewhat since the user could vote on a topic, then view results
  146. and change his vote to reflect the majority.  User feedback would be
  147. appreciated in this matter.
  148.  
  149. MULTILINE SYSTEMS:
  150.  
  151.      The Voting Booth has not been tested on a multiline BBS since nobody's
  152. donated a multi-serial board ;)... I can envision strange things occuring
  153. if two users were to add topics at the same time and try to save.  Anyway
  154. I need feedback to know where problems occur... the config file could be
  155. loaded in after every menu command to ensure it's up-to-date with any
  156. changes that might occur.
  157.  
  158. DATA FILES:
  159.  
  160.     Once you've run the booth for a while, you'll probably figure out
  161. the way the data files are setup.  I won't bother explaining it in the
  162. documentation because I want to discourage people from editing the files
  163. behind the scenes.  If you plan on editing them in your favorite text
  164. editor, make sure you understand the format completely or the program may
  165. crash.  I've put in some error checking if the files are missing, but if
  166. they exist and have been tampered with, your computer may crash.
  167.  
  168.  
  169. FINAL NOTE:
  170.  
  171.     My apologies to those people who like long documentation files
  172. explaining in detail every aspect of the program.  This time I've included
  173. a capture of my setup so I hope it makes things easier.  Once again, if
  174. you happen to find some bugs in the program or would like to see a feature
  175. added to the Voting Booth, don't hesitate to contact me. I've got all summer
  176. to do all sorts of modifications :)
  177.  
  178. You can reach me by sending email to:
  179.  
  180.         tom@manning.cs.ualberta.ca
  181.  
  182. or calling:
  183.  
  184.         The Spectre BBS (2400 soon 14.4)
  185.         (403) 435-9486
  186.         Edmonton, AB
  187.  
  188. or sending snail mail to:
  189.  
  190.         Tom Warkentin
  191.         1016 Buchanan Place
  192.         Edmonton, AB
  193.         T6R 2A7
  194.  
  195. DISCLAIMER:
  196.  
  197.     This software comes with absolutely no guarantee and I will not
  198. be held responsible for it destroying your computer and munching your
  199. hard drive.  USE IT AT YOUR OWN RISK!  Having said that, I can assure
  200. you that I haven't had any problems with it on my system.  If you do find
  201. a problem with the software, I'd appreciate knowing about it so I can fix
  202. it!
  203.  
  204. ---------------------------------------------------------------------------
  205. HISTORY:
  206.  
  207. v1.0b -  fixed an echo problem created by the new DLG update (v0.991);
  208.          menus ignore invalid keypresses instead of redrawing.
  209. v1.0  -  added color, finished up SysOp menu, fixed a bug that didn't print
  210.      a [-] in the Review a Topic menu for those topics the user had not
  211.      voted for.
  212. v0.7  -  finished "Add New Topic", "Delete Topic", and started on the SysOp
  213.      menu.
  214. v0.5  -  started working on user additions.
  215. v0.1  -  beautiful moment when the data files were read in properly and the
  216.      first and only menu was displayed correctly.
  217. ---------------------------------------------------------------------------
  218. THANK YOU's:
  219.  
  220.     Paul for the late night calls on how to fix bugs in C, even though
  221. he's never programmed anything in C himself :)! Yusuf for the ideas for the
  222. voting booth.  Cam for displaying an interest in the completion of the
  223. booth.
  224.